/// @file
/// @author David Pilger <dpilger26@gmail.com>
/// [GitHub Repository](https://github.com/dpilger26/NumCpp)
/// @version 2.1.0
///
/// @section License
/// Copyright 2020 David Pilger
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy of this
/// software and associated documentation files(the "Software"), to deal in the Software
/// without restriction, including without limitation the rights to use, copy, modify,
/// merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
/// permit persons to whom the Software is furnished to do so, subject to the following
/// conditions :
///
/// The above copyright notice and this permission notice shall be included in all copies
/// or substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
/// PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
/// DEALINGS IN THE SOFTWARE.
///
/// @section Description
/// samples a 1D gaussian of input mean and sigma
///
#pragma once

#include "NumCpp/Utils/sqr.hpp"

#include <cmath>

namespace nc
{
    namespace utils
    {
        //============================================================================
        // Method Description:
        ///						samples a 1D gaussian of input mean and sigma
        ///
        /// @param				inX
        /// @param              inMu
        /// @param              inSigma
        ///
        /// @return             dtype
        ///
        inline double gaussian1d(double inX, double inMu, double inSigma) noexcept
        {
            double exponent = sqr(inX - inMu);
            exponent /= 2;
            exponent /= sqr(inSigma);
            return std::exp(-exponent);
        }
    }  // namespace utils
}  // namespace nc
